home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 April: Mac OS SDK / Dev.CD Apr 99 SDK1.toast / Development Kits / Interfaces&Libraries / Universal / Interfaces / PInterfaces / QD3DStorage.p < prev    next >
Encoding:
Text File  |  1998-08-17  |  6.1 KB  |  154 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        QD3DStorage.p
  3.  
  4.      Contains:    Abstraction to deal with various types of stream-based storage devices        
  5.  
  6.      Version:    Technology:    Quickdraw 3D 1.5.4
  7.                  Release:    Universal Interfaces 3.2
  8.  
  9.      Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10.  
  11.      Bugs?:        For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. }
  17. {$IFC UNDEFINED UsingIncludes}
  18. {$SETC UsingIncludes := 0}
  19. {$ENDC}
  20.  
  21. {$IFC NOT UsingIncludes}
  22.  UNIT QD3DStorage;
  23.  INTERFACE
  24. {$ENDC}
  25.  
  26. {$IFC UNDEFINED __QD3DSTORAGE__}
  27. {$SETC __QD3DSTORAGE__ := 1}
  28.  
  29. {$I+}
  30. {$SETC QD3DStorageIncludes := UsingIncludes}
  31. {$SETC UsingIncludes := 1}
  32.  
  33. {$IFC UNDEFINED __QD3D__}
  34. {$I QD3D.p}
  35. {$ENDC}
  36.  
  37. {$IFC TARGET_OS_MAC }
  38. {$IFC UNDEFINED __MACTYPES__}
  39. {$I MacTypes.p}
  40. {$ENDC}
  41. {$IFC UNDEFINED __FILES__}
  42. {$I Files.p}
  43. {$ENDC}
  44. {$ENDC}  {TARGET_OS_MAC}
  45.  
  46.  
  47. {$PUSH}
  48. {$ALIGN POWER}
  49. {$LibExport+}
  50.  
  51. {*****************************************************************************
  52.  **                                                                             **
  53.  **                                Storage Routines                             **
  54.  **                                                                             **
  55.  ****************************************************************************}
  56. FUNCTION Q3Storage_GetType(storage: TQ3StorageObject): TQ3ObjectType; C;
  57. FUNCTION Q3Storage_GetSize(storage: TQ3StorageObject; VAR size: UInt32): TQ3Status; C;
  58. { 
  59.  *    Reads "dataSize" bytes starting at offset in storage, copying into data. 
  60.  *    sizeRead returns the number of bytes filled in. 
  61.  *    
  62.  *    You may assume if *sizeRead < dataSize, then EOF is at offset + *sizeRead
  63.  }
  64. FUNCTION Q3Storage_GetData(storage: TQ3StorageObject; offset: UInt32; dataSize: UInt32; VAR data: UInt8; VAR sizeRead: UInt32): TQ3Status; C;
  65. { 
  66.  *    Write "dataSize" bytes starting at offset in storage, copying from data. 
  67.  *    sizeWritten returns the number of bytes filled in. 
  68.  *    
  69.  *    You may assume if *sizeRead < dataSize, then EOF is at offset + *sizeWritten
  70.  }
  71. FUNCTION Q3Storage_SetData(storage: TQ3StorageObject; offset: UInt32; dataSize: UInt32; {CONST}VAR data: UInt8; VAR sizeWritten: UInt32): TQ3Status; C;
  72. {*****************************************************************************
  73.  **                                                                             **
  74.  **                             Memory Storage Prototypes                         **
  75.  **                                                                             **
  76.  ****************************************************************************}
  77. FUNCTION Q3MemoryStorage_GetType(storage: TQ3StorageObject): TQ3ObjectType; C;
  78. {
  79.  * These calls COPY the buffer into QD3D space
  80.  }
  81. FUNCTION Q3MemoryStorage_New({CONST}VAR buffer: UInt8; validSize: UInt32): TQ3StorageObject; C;
  82. FUNCTION Q3MemoryStorage_Set(storage: TQ3StorageObject; {CONST}VAR buffer: UInt8; validSize: UInt32): TQ3Status; C;
  83. {
  84.  * These calls use the pointer given - you must dispose it when you're through
  85.  }
  86. FUNCTION Q3MemoryStorage_NewBuffer(buffer: Ptr; validSize: UInt32; bufferSize: UInt32): TQ3StorageObject; C;
  87. FUNCTION Q3MemoryStorage_SetBuffer(storage: TQ3StorageObject; buffer: Ptr; validSize: UInt32; bufferSize: UInt32): TQ3Status; C;
  88. FUNCTION Q3MemoryStorage_GetBuffer(storage: TQ3StorageObject; VAR buffer: Ptr; VAR validSize: UInt32; VAR bufferSize: UInt32): TQ3Status; C;
  89. {$IFC TARGET_OS_MAC }
  90. {*****************************************************************************
  91.  **                                                                             **
  92.  **                                Macintosh Handles Prototypes                 **
  93.  **                                                                             **
  94.  ****************************************************************************}
  95. { Handle Storage is a subclass of Memory Storage }
  96. FUNCTION Q3HandleStorage_New(handle: Handle; validSize: UInt32): TQ3StorageObject; C;
  97. FUNCTION Q3HandleStorage_Set(storage: TQ3StorageObject; handle: Handle; validSize: UInt32): TQ3Status; C;
  98. FUNCTION Q3HandleStorage_Get(storage: TQ3StorageObject; VAR handle: Handle; VAR validSize: UInt32): TQ3Status; C;
  99. {*****************************************************************************
  100.  **                                                                             **
  101.  **                                Macintosh Storage Prototypes                 **
  102.  **                                                                             **
  103.  ****************************************************************************}
  104. FUNCTION Q3MacintoshStorage_New(fsRefNum: INTEGER): TQ3StorageObject; C;
  105. { Note: This storage is assumed open }
  106. FUNCTION Q3MacintoshStorage_Set(storage: TQ3StorageObject; fsRefNum: INTEGER): TQ3Status; C;
  107. FUNCTION Q3MacintoshStorage_Get(storage: TQ3StorageObject; VAR fsRefNum: INTEGER): TQ3Status; C;
  108. FUNCTION Q3MacintoshStorage_GetType(storage: TQ3StorageObject): TQ3ObjectType; C;
  109.  
  110. {*****************************************************************************
  111.  **                                                                             **
  112.  **                            Macintosh FSSpec Storage Prototypes                 **
  113.  **                                                                             **
  114.  ****************************************************************************}
  115. FUNCTION Q3FSSpecStorage_New({CONST}VAR fs: FSSpec): TQ3StorageObject; C;
  116. FUNCTION Q3FSSpecStorage_Set(storage: TQ3StorageObject; {CONST}VAR fs: FSSpec): TQ3Status; C;
  117. FUNCTION Q3FSSpecStorage_Get(storage: TQ3StorageObject; VAR fs: FSSpec): TQ3Status; C;
  118. {$ENDC}  {TARGET_OS_MAC}
  119.  
  120. {$IFC TARGET_OS_WIN32 }
  121. {*****************************************************************************
  122.  **                                                                             **
  123.  **                            Win32 HANDLE Storage Prototypes                     **
  124.  **                                                                             **
  125.  ****************************************************************************}
  126. FUNCTION Q3Win32Storage_New(hFile: HANDLE): TQ3StorageObject; C;
  127. FUNCTION Q3Win32Storage_Set(storage: TQ3StorageObject; hFile: HANDLE): TQ3Status; C;
  128. FUNCTION Q3Win32Storage_Get(storage: TQ3StorageObject; VAR hFile: HANDLE): TQ3Status; C;
  129. {$ENDC}  {TARGET_OS_WIN32}
  130.  
  131.  
  132. {*****************************************************************************
  133.  **                                                                             **
  134.  **                                Unix Path Prototypes                         **
  135.  **                                                                             **
  136.  ****************************************************************************}
  137. FUNCTION Q3UnixPathStorage_New(pathName: ConstCStringPtr): TQ3StorageObject; C;
  138. { C string }
  139. FUNCTION Q3UnixPathStorage_Set(storage: TQ3StorageObject; pathName: ConstCStringPtr): TQ3Status; C;
  140. { C string }
  141. FUNCTION Q3UnixPathStorage_Get(storage: TQ3StorageObject; pathName: CStringPtr): TQ3Status; C;
  142. { pathName is a buffer }
  143.  
  144. {$ALIGN RESET}
  145. {$POP}
  146.  
  147. {$SETC UsingIncludes := QD3DStorageIncludes}
  148.  
  149. {$ENDC} {__QD3DSTORAGE__}
  150.  
  151. {$IFC NOT UsingIncludes}
  152.  END.
  153. {$ENDC}
  154.